SolarRadiationInit Subroutine

SUBROUTINE SolarRadiationInit &
!
( ini, mask, dtMeteo, tstart, dem, dem_loaded, albedo_loaded, &
  dtTemperature, dtRelHumidity )

IMPLICIT NONE

TYPE (IniList), INTENT(IN) :: ini
TYPE (grid_integer), INTENT(IN) :: mask  !!defines interpolation extent
INTEGER (KIND = short), INTENT(IN) :: dtMeteo !! deltat of meteo data reading
TYPE (DateTime),     INTENT(IN) :: tstart !!initial time
TYPE(grid_real),    INTENT(in)  :: dem !!digital elevation model to be used to modify interpolated data
LOGICAL , INTENT (in) :: dem_loaded !! true if dem has been loaded
LOGICAL , INTENT (in) :: albedo_loaded !! true if dem has been loaded
INTEGER (KIND = short), INTENT(IN) :: dtTemperature !! delta time temperature
INTEGER (KIND = short), INTENT(IN) :: dtRelHumidity !! delta time relative humidity



!local declarations
CHARACTER (LEN = 1000) :: filename
TYPE (grid_real) :: meteoTemp


!-------------------------end of declarations----------------------------------
  
!check if albedo and dem have been loaded by domain properties
IF ( .NOT. dem_loaded) THEN
    CALL Catch ('error', 'SolarRadiation',   &
                'dem  was not loaded ')
END IF
      
IF ( .NOT. albedo_loaded) THEN
    CALL Catch ('error', 'SolarRadiation',   &
                'albedo  was not loaded ')
END IF

!check if air temperature and relative humidity have been initialized
IF ( dtTemperature <= 0) THEN
    CALL Catch ('error', 'SolarRadiation',   &
                'air temperature not initialized ')
END IF
      
IF ( dtRelHumidity <= 0) THEN
    CALL Catch ('error', 'SolarRadiation',   &
                'air relative humidity not initialized ')
END IF

  !set initial time
  timeNew = tstart  

  !initialize grid
  CALL NewGrid (radiation, mask, 0.)
  CALL NewGrid (grid_devst, mask, 0.)
  
  !set deltat
  dtRadiation = IniReadInt ('dt', ini, section = 'solar-radiation')

	!check dt is multiple of dtMeteo
  IF (.NOT.(MOD(dtRadiation,dtMeteo) == 0)) THEN
           CALL Catch ('error', 'SolarRadiation',   &
		                 'dt is not multiple of dtMeteo')
  END IF
  
  !set valid threshold
  IF (KeyIsPresent ('valid-threshold', ini, &
                         section = 'solar-radiation') ) THEN
      valid_prcn = IniReadReal ('valid-threshold', ini, &
                                        section = 'solar-radiation')
  ELSE ! set to default = 1.0 
      CALL Catch ('info', 'SolarRadiation',   &
		                 'valid-threshold not defined, set to 1')
      valid_prcn = 1.
  END IF

  !set cell-size
  cellsizeInterpolation = mask % cellsize

  
  !interpolation-assignment method
  IF (KeyIsPresent('interpolation-assignment', ini, &
                     section = 'solar-radiation') ) THEN
      interpolationMethod_assignment = IniReadInt ('interpolation-assignment', &
                                     ini, section = 'solar-radiation')
  ELSE
    CALL Catch ('error', 'SolarRadiation',   &
                'interpolation-assignment missing in meteo configuration file')
  END IF   

  !set interpolation method
  IF (interpolationMethod_assignment == 1) THEN

      interpolationMethod = IniReadInt ('interpolation', ini, &
                                    section = 'solar-radiation')
      
	    CALL SetSpecificProperties (interpolationMethod, ini, mask)
  
  ELSE !read map
      interpolationMethod = -1
      CALL GridByIni (ini, interpolationMethod_map, 'solar-radiation', &
                     "interpolation")
      !scan for interpolation methods included
      interpolationMethod_vector = 0
      DO i = 1, interpolationMethod_map % idim
        DO j = 1, interpolationMethod_map % jdim
            IF (interpolationMethod_map % mat(i,j) /= &
                interpolationMethod_map % nodata) THEN
                interpolationMethod_vector &
                   (interpolationMethod_map % mat (i,j)) = &
                    interpolationMethod_map % mat (i,j)
            END IF
        END DO
      END DO

      DO i = 1, 3
         CALL SetSpecificProperties (interpolationMethod_vector (i), ini, mask)
      END DO

  END IF
  
  
  !allocate variable for netradiation
  CALL NewGrid (netRadiation, mask) 
  CALL NewGrid (netRadiationFAO, mask) 
  
  !scale factor and offset
  IF (KeyIsPresent('offset', ini, section = 'solar-radiation')) THEN	
	offset_value = IniReadReal ('offset', ini, section = 'solar-radiation')
  ELSE
	offset_value = MISSING_DEF_REAL
  END IF
	
  IF (KeyIsPresent('scale-factor', ini, section = 'solar-radiation')) THEN	
	scale_factor = IniReadReal ('scale-factor', ini, section = 'solar-radiation')
  ELSE
	scale_factor = MISSING_DEF_REAL
  END IF			

   !set power_idw
   IF (KeyIsPresent('idw-power', ini, section = 'solar-radiation')) THEN	
	   idw_power = IniReadReal ('idw-power', ini, section = 'solar-radiation')
   ELSE !set default value
	    idw_power = 2.
   END IF	
 
	!file
    filename = IniReadString ('file', ini, section = 'solar-radiation')
    IF (interpolationMethod_assignment == 1 .AND. &
        interpolationMethod == 0) THEN !data are stored in net-cdf file
        
       !store net-cdf filename
       fileGrid = filename
       
       IF ( KeyIsPresent ('variable', ini, section = 'solar-radiation') ) THEN
          radiation % var_name = IniReadString ('variable', &
                                             ini, section = 'solar-radiation')
            !read grid and store as temporary file
             CALL NewGrid (layer = meteoTemp, fileName = TRIM(fileGrid), &
                         fileFormat = NET_CDF, &
                         variable = TRIM(radiation % var_name) )
       ELSE IF  (KeyIsPresent ('standard_name', ini, &
                              section = 'solar-radiation') ) THEN
          radiation % standard_name = IniReadString ('standard_name', &
                                              ini, section = 'solar-radiation')
       ELSE
          CALL Catch ('error', 'SolarRadiation',   &
		       'standard_name or variable missing in section temeprature' )
       END IF      

       !set cellsize to zero. Optimal cellsize is automatically computed
       cellsizeInterpolation = 0.
            
    ELSE !open file containing local measurements
       fileunit = GetUnit ()
	     OPEN(fileunit, file = filename(1:LEN_TRIM(filename)),status='old')
    END IF
    
  !use elevation to drift interpolation
  IF ( KeyIsPresent ('elevation-drift', ini, section = 'solar-radiation') ) THEN
	     elevationDrift = IniReadInt ('elevation-drift', ini, section = &
                                      'solar-radiation')
  ELSE
      elevationDrift = 0 !default, suppress drift
  END IF
  
  IF (elevationDrift == 1) THEN
      
     
      IF (interpolationMethod == 0 ) THEN
          CALL Catch ('error', 'SolarRadiation',   &
                'elevation drift cannot be applied when interpolation = 0 ')
      END IF
      
      IF ( KeyIsPresent ('time-zone', ini, section = 'solar-radiation') ) THEN
	     timezone = IniReadInt ('time-zone', ini, section = &
                                      'solar-radiation')
      ELSE
          CALL Catch ('error', 'SolarRadiation',   &
		       'timezone is missing' )
      END IF

      
       !set azimuth angles to compute shadow and convert to radians
       azimuth = (/0.0, 22.5, 45.0, 67.5, 90.0, 112.5, 135.0, 157.5, &
           180.0, 202.5, 225.0, 247.5, 270.0, 292.5, 315.0, 337.5/)
       
       azimuth = azimuth * degToRad
       
       CALL DeriveSlope  (dem, slope)
                    
       CALL DeriveAspect (dem, aspect)
                    
       CALL NewGrid (shadowGrid, dem)
                    
       ALLOCATE ( viewangle (dem % idim,dem % jdim) )
	
  END IF  
  

  !grid exporting settings
  IF (KeyIsPresent ('export', ini, section = 'solar-radiation')  )  THEN
     export = IniReadInt ('export', ini, section = 'solar-radiation')
  ELSE
     export = 0
  END IF 

  IF (export == 1) THEN
     
     !set export path name
     IF (KeyIsPresent ('export-path', ini, section = 'solar-radiation')  )  THEN
         export_path = IniReadString ('export-path', ini, section = 'solar-radiation')
         !check if path ends with / or \
         IF (  export_path (LEN_TRIM (export_path):LEN_TRIM (export_path)) /= '\' .AND. &
               export_path (LEN_TRIM (export_path):LEN_TRIM (export_path)) /= '/' ) THEN
             export_path (LEN_TRIM (export_path)+1:LEN_TRIM (export_path)+1) = '\'
         END IF
       
         IF (INDEX (export_path,'.') == 1) THEN !detected relative path, remove '.'
            export_path = export_path (2:LEN_TRIM(export_path))
            !build absolute path
            export_path = TRIM(CurrentDir() ) // TRIM(export_path)
         END IF

         !check OS convention
        IF (GetOS () == WIN32) THEN
          export_path = ReplaceChar (export_path,'/','\')
        ELSE
          export_path = ReplaceChar (export_path,'\','/')
        END IF
  
         
         !check folder exists
         IF ( .NOT. DirExists (TRIM (export_path) ) ) THEN
             CALL Catch ('info', 'SolarRadiation',   &
                  'creating directory:  ', argument = TRIM(export_path))
             CALL DirNew (export_path)
         END IF
     ELSE
         CALL Catch ('error', 'SolarRadiation',   &
                  'missing export-path')
     END IF 
     
     !starting time
     IF (KeyIsPresent ('export-start', ini, section = 'solar-radiation')  )  THEN
         timeString = IniReadString ('export-start', ini, 'solar-radiation')
         export_start = timeString
     ELSE
         CALL Catch ('error', 'SolarRadiation',   &
                  'missing export-start')
     END IF 
     
     !initialize timeNewExport
     timeNewExport = export_start
     
     !ending time
     IF (KeyIsPresent ('export-stop', ini, section = 'solar-radiation')  )  THEN
         timeString = IniReadString ('export-stop', ini, 'solar-radiation')
         export_stop = timeString
     ELSE
         CALL Catch ('error', 'SolarRadiation',   &
                  'missing export-start')
     END IF 
     
     !export dt
     IF (KeyIsPresent ('export-dt', ini, section = 'solar-radiation')  )  THEN
         export_dt = IniReadInt ('export-dt', ini, section = 'solar-radiation')
     ELSE
         CALL Catch ('error', 'SolarRadiation',   &
                  'missing export-dt')
     END IF 

     !coordinate reference system
     IF (KeyIsPresent ('export-epsg', ini, section = 'solar-radiation')  )  THEN
         export_epsg = IniReadInt ('export-epsg', ini, section = 'solar-radiation')
         
         exportGridMapping = DecodeEPSG (export_epsg)
         IF (exportGridMapping == radiation % grid_mapping) THEN
            needConversion = .FALSE.
            !initialize grid for exporting with CRS as meteo variable
            CALL NewGrid (exportedGrid, radiation)
            CALL NewGrid (exportedGridVar, radiation)
            CALL NewGrid (exportedGridNet, netRadiation)
         ELSE
            needConversion = .TRUE.
            !initialize grid for converting with required CRS
            exportedGrid % grid_mapping = DecodeEPSG (export_epsg)
            exportedGridVar % grid_mapping = DecodeEPSG (export_epsg)
            exportedGridNet % grid_mapping = DecodeEPSG (export_epsg)
         END IF
     ELSE
         CALL Catch ('info', 'SolarRadiation',   &
                  'export-epsg not defined, use default')
         needConversion = .FALSE.
         !initialize grid for exporting with CRS 
         CALL NewGrid (exportedGrid, radiation)
         CALL NewGrid (exportedGridVar, radiation)
         CALL NewGrid (exportedGridNet, netRadiation)
     END IF 

     !export file format 
     IF (KeyIsPresent ('export-format', ini, section = 'solar-radiation')  )  THEN
         export_format = IniReadInt ('export-format', ini, section = 'solar-radiation')
     ELSE
         CALL Catch ('error', 'SolarRadiation',   &
                  'missing export-format')
     END IF 

     IF (export_format == 3) THEN
       !grid map  
       CALL SetLongName ( 'downwelling_shortwave_flux_in_air', exportedGrid)
       CALL SetLongName ( 'net_downward_flux_in_air', exportedGridNet)
       CALL SetStandardName ( 'downwelling_shortwave_flux_in_air', exportedGrid)
       CALL SetStandardName ( 'net_downward_flux_in_air', exportedGridNet)
       CALL SetUnits ('Wm-2', exportedGrid) 
       CALL SetUnits ('Wm-2', exportedGridNet) 
       !if file exists, remove it
       export_file = TRIM(export_path) //  'radiation.nc'
       IF ( FileExists (export_file) ) THEN
          CALL FileDelete (export_file)
       END IF
       export_file_net = TRIM(export_path) //  'net_radiation.nc'
       IF ( FileExists (export_file_net) ) THEN
          CALL FileDelete (export_file_net)
       END IF
       
       !variance of kriging 
       CALL SetLongName ( 'downwelling_shortwave_flux_in_air_variance', exportedGridVar)
       CALL SetStandardName ( 'downwelling_shortwave_flux_in_air_variance', exportedGridVar)
       CALL SetUnits ('Wm-2', exportedGridVar) !this unit is for exporting grid
       !if file exists, remove it
       export_file_var = TRIM(export_path) //  'radiation_variance.nc'
       IF ( FileExists (export_file_var) ) THEN
          CALL FileDelete (export_file_var)
       END IF
       
     END IF

  END IF
	
  !complete initialization

  IF (interpolationMethod == 0) THEN
        !Get the dt of imported  field. Assume dt is regular	
        dtGrid = GetDtGrid (filename = fileGrid, checkRegular = .TRUE.)
        !check dt is multiple of dtGrid
        IF (.NOT.(MOD(dtRadiation,dtGrid) == 0)) THEN
            CALL Catch ('error', 'SolarRadiation',   &
                'dt solar radiation is not multiple of dt of input grid')
        END IF
  ELSE
        !populate  metadata
        CALL ReadMetadata (fileunit, radiometers)

        !check spatial reference system
        IF ( .NOT. radiometers % mapping == mask % grid_mapping)  THEN
            CALL Catch ('info', 'SolarRadiation',   &
		              'converting coordinate of stations')
            !convert stations' coordinate
            point1 % system = radiometers % mapping
            point2 % system = mask % grid_mapping
            radiometers % mapping = mask % grid_mapping
            DO i = 1, radiometers % countObs
              point1 % easting = radiometers % obs (i) % xyz % easting
              point1 % northing = radiometers % obs (i) % xyz % northing
              point1 % elevation = radiometers % obs (i) % z
              CALL Convert (point1, point2)
              radiometers % obs (i) % xyz % easting = point2 % easting
              radiometers % obs (i) % xyz % northing = point2 % northing 
            END DO
        END IF
        
  END IF !interpolationMethod
   
RETURN
  END SUBROUTINE SolarRadiationInit